AccessToken
获取access-token
access-token的值是根据用户的用户名和密码生成的区别其他用户的值,用于验证使用接口的用户的合法性。
token随时都有可能过期的,目前token有效期是7天,我们建议每次使用执行脚本时都获取一遍token。
请求地址
POST
http://OmsAddress/app/newoms.php/webservice/token?cmd=10000&ip-type=webservicerest
创建webservice用户
打开OMS控制台"业务管理 > 访问WebServiceAPI配置 > WebService 用户"页面,新增绑定webservice用户并联系DBA激活后使用
POST请求参数说明
参数名称 | 数组类型 | 说明 | 是否必填字段 | 备注 |
---|---|---|---|---|
username | 字符串 | 用户名 | 是 | |
password | 字符串 | 用户密码 | 是 | |
register_type | 整型 | 用户账户注册方式 2 : webservice用户认证 | 否 |
Data参数
使用json格式表示记录相关信息,示例如下:
{
"username": "tcaplus",
"register_type": 2,
"password": "tcaplus"
}
返回语法
返回参数说明
字段名称 | 数据类型 | 说明 | 备注 |
---|---|---|---|
code | 整型 | 为0,成功返回;非0,错误返回 | |
error | 字符串 | code不为0时的错误信息 | |
token | 字符串 | code为0时,获取到的指定用户的token值 |
请求示例
通过 curl 方法发起请求
curl -H "Content-type: application/json" -X "POST" -d '{
"username": "tcaplus",
"register_type": 2,
"password": "tcaplus"
}' 'http://omsaddress/app/newoms.php/webservice/token?cmd=10000&ip-type=webservicerest'
返回示例
成功返回示例
http请求的Status=200
{
"code": 0,
"error": "",
"token": "081dcfbc6f804d9a9fce29fc2f50076486fff972"
}
错误返回
http请求的Status!=200
{
"source_ip": "ip:10.29.89.51 not in whitelist"
}
{
"code": 1,
"error": "用户名不存在"
}